Configure DM Agent

By default, the DM Agent Deployment Tool is located in the SLNX installer within the Tools subfolder. Double-click the executable to perform configuration.

If this is your first time configuring DM Agent, enter the Connection Settings to the Delegation Server and then proceed with the remainder of the configuration.

Connection Settings

  1. Select the language to be used in this UI.

  2. If the Delegation Server uses SSL, enable the SSL checkbox.

  3. Enter the [Delegation Server Address].

The address should include the protocol, DS server hostname or IP v4 address, and port number in this format: http(s)://<Server Name>:<Port Number>. In case the port number is not specified, the default value will be used based on protocol: 80 if using HTTP and 443 if using HTTPS. If the load balancer is configured for DS and intended to be connected by DM-Agent, its address should be specified here.

The value is stored when "Run Action" is initiated on the Update and Install tab. If you run the tool again, it will display the values previously used.

  1. Enter the [Embedded Security Connection Key].

This is a required field because it is used to communicate with the Delegation Server. The key is stored when "Run Action" is clicked in the Install and Update screen, so if you run the tool again, it will display the values previously used.

  1. Enter the [Device Administrator User name] and [Password]. The administrator account entered here should be a device machine administrator. If the administrator does not have a password, you can leave the password field empty.

  2. Enter the [SDK/J Platform password]. This field is required only if the SDK/J platform is installed on the device. A default password is provided. However, if you leave the default or enter another password, the DM Agent Tool will use the SDK/J platform to install the application on devices. Remove the default password if not required.

  3. Click [Continue].

If you did not supply an Embedded Security Connection key, you will have to clear the error before you can proceed.

Proxy Settings

If not using a proxy server, leave the method list set to 'No proxy', and click [Continue]. If using a proxy server, make the following selections:

  1. Select the Proxy Method.

    Options are Proxy with basic authentication, Proxy with Kerberos authentication or Proxy with NTLM authentcation. The fields that appear in the screen depend on what you selected from this list.

  2. For all proxy authentication types, complete the following fields:
    1. Enter the Proxy Server Address; either hostname or IP address. This field cannot be left blank.
    2. Specify the Server port number.
    3. Enter the User Name and Password that will be used to connect to the authentication server.
  3. For Kerberos Authentication, also enter the following information:

    1. KDC: Enter the Kerberos Key Distribution Center (KDC) server. For example: mycompany.com

    2. Realm: Enter the name of Kerberos realm. For example: mycompany.com

    3. Service Principal Name: Enter the IP address or hostname of the server that performs Kerberos authentication.

  4. Click [Continue].

The connection from the Delegation Server to the selected authentication method is tested. If the Embedded Connection Key is not valid, you will see an error message indicating "Invalid Embedded Connection Key. Would you like to proceed?". If you click [Continue], you can proceed to the next tabs in the configuration.

If the authentication method is Kerberos, and any setting in invalid, an error message is displayed.

Firmware

  1. To select the Firmware for a specific device model, click [Browse]. Locate the firmware pkg/rfu files. Once you select a package, the .pkg name is shown to the right of the Browse button.

    You can use the filter function to determine if any matching device models and firmware packages have previously been uploaded.

  2. Select the corresponding Device Model from the list.

  3. Click [Select] to upload the .pkg/rfu file information to the table.

  4. If the selected model is chosen that was matched with another firmware package, you will see an error indicating "There is already a firmware for the selected device model. Would you like to replace it"? Click OK to proceed with your selection, or Cancel to select another device model or firmware package.

    If you need to delete previous firmware packages, use the Delete function. To select all packages, enable the Firmware Image checkbox in the table header to select all packages before you click Delete.

  5. If “Update Firmware” Action is selected in Update Install Tab and no Firmware is selected for the specific device model, you will be redirected to this tab to select firmware.
  6. Click [Continue].

Network Range List

  1. Click the Add button and select the Range type in the Select Devices screen.

    • One hostname: If selected, enter the hostname of a device.

    • One IP Address: If selected, enter the IPv4 of the device.

    • Specify IP Range: If selected, enter an IP address in [From] and [To] then specify the [Subnet Mask]. If more than 512 IP addresses are selected, a warning message is shown to allow you to cancel or continue.

  1. (Optional) You also have the option to import the device range list in CSV format. Click the Import button to upload the file. Here is a sample import/export file format.

Line 1: "From","To","Subnet Mask"

Succeeding lines:"10.85.7.1","10.85.7.255","255.255.255.0"

Line 1 must have the text "From","To","Subnet Mask", then write the IP address range in the succeeding lines.

If you want to input one IP Address, add the following line: <IP Address>,,,

If you want to input a hostname, add the following line: <hostname>,,,

You can also download the list of IP Address ranges by clicking the Export button.

  1. Click [Continue] to perform device discovery. Each device discovered will be displayed in the Update and Install tab.
  2. While discovery is in process, a Stop Process button appears on the screen. You can press this option at any time to stop the discovery mid-process. When the discovery is complete the Stop Process button is replaced by the label "Number of Devices" to indicate the total number of devices found. Click Discovery Log to download the log and troubleshoot any devices with a 'not found' or 'not supported' status.

Update and Install

  1. Select an Action from the list.

    • Install DM Agent - run this action to install the DM Agent on the device(s) for the first time, to update the existing application if necessary, or to update security information on the selected devices in the event there are changes to connection settings.

    • Uninstall DM Agent - remove the agent from the selected devices.

    • Update Firmware - install the firmware on the selected devices.

    • Reinitialize - allows the tool to automatically reinitialize the Embedded application if it is already installed on the selected devices.

  2. Select the devices you want to apply the action to. You can also use the filter button to find specific devices if necessary. The action will be completed only on checked devices.

    • The DM Agent column indicates the version of the DM Agent tool currently installed on the device. This column can be helpful when determining which devices to select if running the Install DM Agent task. The column displays - character if DM Agent is not installed.
    • The Firmware Version column may be empty if the device language is not English, or there is a problem retrieving the firmware information from the device.
    • The Firmware Status column displays "Yes" if the firmware version meets the minimum required firmware and displays "No" if below the minimum version. The Status will be empty if there is a problem retrieving the firmware information from the device.

  3. Click [Run Action] to perform the task. Possible error messages may include: 

    • If Update Firmware is selected as the action but the table from the Firmware Tab is empty, an error message is displayed and the action does not proceed.

    • If the device model selected does not have selected firmware from the Firmware Tab, an error message indicating the model that needs firmware.

If initial problems are not found, you will see a progress bar beside the (Run Action) button to indicate that the activity is ongoing.

The Result column in the table to indicates the result of the action. You will see "failed" if the process failed, or "succeeded" if the process is complete. The other columns in the table are updated accordingly.

Summary

Check the Summary screen to see the status of the applied action from the Update and Install tab. This tab provides the paths to the Trace Log and the Device Trace log for troubleshooting purposes. Use the Download Log button for quick access.